<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>glGetFramebufferParameter - OpenGL 4 Reference Pages</title>
    <link rel="stylesheet" type="text/css" href="opengl-man.css"/>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
    <script type="text/x-mathjax-config">
            MathJax.Hub.Config({
                MathML: {
                    extensions: ["content-mathml.js"]
                },
                tex2jax: {
                    inlineMath: [['$','$'], ['\\(','\\)']]
                }
            });
        </script>
    <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
  </head>
  <body>
    <header/>
    <div class="refentry" id="glGetFramebufferParameter">
      <div class="titlepage"/>
      <div class="refnamediv">
        <h2>Name</h2>
        <p>glGetFramebufferParameteriv, glGetNamedFramebufferParameteriv — query a named parameter of a framebuffer object</p>
      </div>
      <div class="refsynopsisdiv">
        <h2>C Specification</h2>
        <div class="funcsynopsis">
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">void <strong class="fsfunc">glGetFramebufferParameteriv</strong>(</code>
              </td>
              <td>GLenum <var class="pdparam">target</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLenum <var class="pdparam">pname</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLint *<var class="pdparam">params</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">void <strong class="fsfunc">glGetNamedFramebufferParameteriv</strong>(</code>
              </td>
              <td>GLuint <var class="pdparam">framebuffer</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLenum <var class="pdparam">pname</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLint *<var class="pdparam">param</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
        </div>
      </div>
      <div class="refsect1" id="parameters">
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>target</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    Specifies the target to which the framebuffer object is
                    bound for
                    <code class="function">glGetFramebufferParameteriv</code>.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>framebuffer</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    Specifies the name of the framebuffer object for
                    <code class="function">glGetNamedFramebufferParameteriv</code>.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>pname</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    Specifies the parameter of the framebuffer object to
                    query.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>params</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    Returns the value of parameter
                    <em class="parameter"><code>pname</code></em> for the framebuffer object.
                </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1" id="description">
        <h2>Description</h2>
        <p>
            <code class="function">glGetFramebufferParameteriv</code> and
            <code class="function">glGetNamedFramebufferParameteriv</code> query
            parameters of a specified framebuffer object.
        </p>
        <p>
            For <code class="function">glGetFramebufferParameteriv</code>,
            the framebuffer object is that bound to
            <em class="parameter"><code>target</code></em>, which must be one of
            <code class="constant">GL_DRAW_FRAMEBUFFER</code>,
            <code class="constant">GL_READ_FRAMEBUFFER</code> or
            <code class="constant">GL_FRAMEBUFFER</code>.
            <code class="constant">GL_FRAMEBUFFER</code> is equivalent to
            <code class="constant">GL_DRAW_FRAMEBUFFER</code>. Default framebuffers
            may also be queried if bound to <em class="parameter"><code>target</code></em>.
        </p>
        <p>
            For <code class="function">glGetNamedFramebufferParameteriv</code>,
            <em class="parameter"><code>framebuffer</code></em> is the name of the
            framebuffer object. If <em class="parameter"><code>framebuffer</code></em> is
            zero, the default draw framebuffer is queried.
        </p>
        <p>
            Upon successful return, <em class="parameter"><code>param</code></em> will
            contain the value of the framebuffer parameter specified by
            <em class="parameter"><code>pname</code></em>, as described below.
        </p>
        <p>
            The following parameters can only be queried for framebuffer objects:
        </p>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <code class="constant">GL_FRAMEBUFFER_DEFAULT_WIDTH</code>
              </span>
            </dt>
            <dd>
              <p>
                        <em class="parameter"><code>params</code></em> returns the value of
                        <code class="constant">GL_FRAMEBUFFER_DEFAULT_WIDTH</code>
                        for the framebuffer object.
                    </p>
            </dd>
            <dt>
              <span class="term">
                <code class="constant">GL_FRAMEBUFFER_DEFAULT_HEIGHT</code>
              </span>
            </dt>
            <dd>
              <p>
                        <em class="parameter"><code>params</code></em> returns the value of
                        <code class="constant">GL_FRAMEBUFFER_DEFAULT_HEIGHT</code>
                        for the framebuffer object.
                    </p>
            </dd>
            <dt>
              <span class="term">
                <code class="constant">GL_FRAMEBUFFER_DEFAULT_LAYERS</code>
              </span>
            </dt>
            <dd>
              <p>
                        <em class="parameter"><code>params</code></em> returns the value of
                        <code class="constant">GL_FRAMEBUFFER_DEFAULT_LAYERS</code>
                        for the framebuffer object.
                    </p>
            </dd>
            <dt>
              <span class="term">
                <code class="constant">GL_FRAMEBUFFER_DEFAULT_SAMPLES</code>
              </span>
            </dt>
            <dd>
              <p>
                        <em class="parameter"><code>params</code></em> returns the value of
                        <code class="constant">GL_FRAMEBUFFER_DEFAULT_SAMPLES</code>
                        for the framebuffer object.
                    </p>
            </dd>
            <dt>
              <span class="term">
                <code class="constant">GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</code>
              </span>
            </dt>
            <dd>
              <p>
                        <em class="parameter"><code>params</code></em> returns the boolean
                        value of
                        <code class="constant">GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</code>.
                    </p>
            </dd>
          </dl>
        </div>
        <p>
            The following parameters can be queried for both default framebuffers 
            and framebuffer objects:
        </p>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <code class="constant">GL_DOUBLEBUFFER</code>
              </span>
            </dt>
            <dd>
              <p>
                        <em class="parameter"><code>param</code></em> returns a boolean value
                        indicating whether double buffering is supported for
                        the framebuffer object.
                    </p>
            </dd>
            <dt>
              <span class="term">
                <code class="constant">GL_IMPLEMENTATION_COLOR_READ_FORMAT</code>
              </span>
            </dt>
            <dd>
              <p>
                        <em class="parameter"><code>param</code></em> returns a GLenum value
                        indicating the preferred pixel data format for the
                        framebuffer object. See
                        <a class="citerefentry" href="glReadPixels.xhtml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>.
                    </p>
            </dd>
            <dt>
              <span class="term">
                <code class="constant">GL_IMPLEMENTATION_COLOR_READ_TYPE</code>
              </span>
            </dt>
            <dd>
              <p>
                        <em class="parameter"><code>param</code></em> returns a GLenum value
                        indicating the implementation's preferred pixel data
                        type for the framebuffer object. See
                        <a class="citerefentry" href="glReadPixels.xhtml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>.
                    </p>
            </dd>
            <dt>
              <span class="term">
                <code class="constant">GL_SAMPLES</code>
              </span>
            </dt>
            <dd>
              <p>
                        <em class="parameter"><code>param</code></em> returns an integer
                        value indicating the coverage mask size for the
                        framebuffer object. See
                        <a class="citerefentry" href="glSampleCoverage.xhtml"><span class="citerefentry"><span class="refentrytitle">glSampleCoverage</span></span></a>.
                    </p>
            </dd>
            <dt>
              <span class="term">
                <code class="constant">GL_SAMPLE_BUFFERS</code>
              </span>
            </dt>
            <dd>
              <p>
                        <em class="parameter"><code>param</code></em> returns an integer
                        value indicating the number of sample buffers
                        associated with the framebuffer object. See
                        <a class="citerefentry" href="glSampleCoverage.xhtml"><span class="citerefentry"><span class="refentrytitle">glSampleCoverage</span></span></a>.
                    </p>
            </dd>
            <dt>
              <span class="term">
                <code class="constant">GL_STEREO</code>
              </span>
            </dt>
            <dd>
              <p>
                        <em class="parameter"><code>param</code></em> returns a boolean value
                        indicating whether stereo buffers (left and right)
                        are supported for the framebuffer object.
                    </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1" id="notes">
        <h2>Notes</h2>
        <p>
            Queries of default framebuffers are supported only if the GL
            version is 4.5 or higher. Otherwise, an
            <code class="constant">GL_INVALID_OPERATION</code> error is generated.
        </p>
        <p>
            Queries of the framebuffer-dependent parameters
            <code class="constant">GL_DOUBLEBUFFER</code>,
            <code class="constant">GL_IMPLEMENTATION_COLOR_READ_FORMAT</code>,
            <code class="constant">GL_IMPLEMENTATION_COLOR_READ_TYPE</code>,
            <code class="constant">GL_SAMPLES</code>,
            <code class="constant">GL_SAMPLE_BUFFERS</code> and
            <code class="constant">GL_STEREO</code> are supported only if the GL
            version is 4.5 or higher.
        </p>
        <p>
            The framebuffer-dependent state
            <code class="constant">GL_SAMPLE_POSITION</code> cannot be queried
            with these commands.
        </p>
      </div>
      <div class="refsect1" id="errors">
        <h2>Errors</h2>
        <p>
            <code class="constant">GL_INVALID_ENUM</code> is generated by
            <code class="function">glGetFramebufferParameteriv</code> if
            <em class="parameter"><code>target</code></em> is not one of the accepted
            framebuffer targets.
        </p>
        <p>
            <code class="constant">GL_INVALID_OPERATION</code> is generated by
            <code class="function">glGetNamedFramebufferAttachmentParameteriv</code>
            if <em class="parameter"><code>framebuffer</code></em> is not zero or the name of
            an existing framebuffer object.
        </p>
        <p>
            <code class="constant">GL_INVALID_ENUM</code> is generated if
            <em class="parameter"><code>pname</code></em> is not one of the accepted
            parameter names.
        </p>
        <p>
            <code class="constant">GL_INVALID_OPERATION</code> is generated if a
            default framebuffer is queried, and <em class="parameter"><code>pname</code></em>
            is not one of <code class="constant">GL_DOUBLEBUFFER</code>,
            <code class="constant">GL_IMPLEMENTATION_COLOR_READ_FORMAT</code>,
            <code class="constant">GL_IMPLEMENTATION_COLOR_READ_TYPE</code>,
            <code class="constant">GL_SAMPLES</code>,
            <code class="constant">GL_SAMPLE_BUFFERS</code> or
            <code class="constant">GL_STEREO</code>.
        </p>
      </div>
      <div class="refsect1" id="associatedgets">
        <h2>Associated Gets</h2>
        <p>
            <a class="citerefentry" href="glGetFramebufferAttachmentParameter.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetFramebufferAttachmentParameter</span></span></a>
        </p>
      </div>
      <div class="refsect1" id="versions">
        <h2>Version Support</h2>
        <div class="informaltable">
          <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
            <colgroup>
              <col style="text-align: left; "/>
              <col style="text-align: center; " class="firstvers"/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; " class="lastvers"/>
            </colgroup>
            <thead>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; ">
                 
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; " colspan="12">
                <span class="bold"><strong>OpenGL Version</strong></span>
            </th>
              </tr>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>Function / Feature Name</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>2.0</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>2.1</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.0</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.1</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.2</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.3</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.0</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.1</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.2</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.3</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.4</strong></span>
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.5</strong></span>
            </th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
                  <code class="function">glGetFramebufferParameteriv</code>
                </td>
                <td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
                <td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
                <td style="text-align: center; border-bottom: 2px solid ; ">✔</td>
              </tr>
              <tr>
                <td style="text-align: left; border-right: 2px solid ; ">
                  <code class="function">glGetNamedFramebufferParameteriv</code>
                </td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; ">✔</td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1" id="seealso">
        <h2>See Also</h2>
        <p>
            <a class="citerefentry" href="glFramebufferParameteri.xhtml"><span class="citerefentry"><span class="refentrytitle">glFramebufferParameteri</span></span></a>,
            <a class="citerefentry" href="glGetFramebufferAttachmentParameter.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetFramebufferAttachmentParameter</span></span></a>
        </p>
      </div>
      <div class="refsect1" id="Copyright">
        <h2>Copyright</h2>
        <p>
            Copyright <span class="trademark"/>© 2014 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
        </p>
      </div>
    </div>
    <footer/>
  </body>
</html>
